-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ObservableInstrument`1.xml
195 lines (192 loc) · 14 KB
/
ObservableInstrument`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<Type Name="ObservableInstrument<T>" FullName="System.Diagnostics.Metrics.ObservableInstrument<T>">
<TypeSignature Language="C#" Value="public abstract class ObservableInstrument<T> : System.Diagnostics.Metrics.Instrument where T : struct" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ObservableInstrument`1<struct .ctor (class System.ValueType) T> extends System.Diagnostics.Metrics.Instrument" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.Metrics.ObservableInstrument`1" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ObservableInstrument(Of T)
Inherits Instrument" />
<TypeSignature Language="F#" Value="type ObservableInstrument<'T (requires 'T : struct)> = class
 inherit Instrument" />
<TypeSignature Language="C++ CLI" Value="generic <typename T>
 where T : value classpublic ref class ObservableInstrument abstract : System::Diagnostics::Metrics::Instrument" />
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<ParameterAttribute>NotNullableValueTypeConstraint</ParameterAttribute>
<BaseTypeName>System.ValueType</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Diagnostics.Metrics.Instrument</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<typeparam name="T">The type that the observable instrument represents.</typeparam>
<summary>ObservableInstrument{T} is the base class from which all metrics observable instruments will inherit.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ObservableInstrument (System.Diagnostics.Metrics.Meter meter, string name, string? unit, string? description);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Diagnostics.Metrics.Meter meter, string name, string unit, string description) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.ObservableInstrument`1.#ctor(System.Diagnostics.Metrics.Meter,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (meter As Meter, name As String, unit As String, description As String)" />
<MemberSignature Language="F#" Value="new System.Diagnostics.Metrics.ObservableInstrument<'T (requires 'T : struct)> : System.Diagnostics.Metrics.Meter * string * string * string -> System.Diagnostics.Metrics.ObservableInstrument<'T (requires 'T : struct)>" Usage="new System.Diagnostics.Metrics.ObservableInstrument<'T (requires 'T : struct)> (meter, name, unit, description)" />
<MemberSignature Language="C++ CLI" Value="protected:
 ObservableInstrument(System::Diagnostics::Metrics::Meter ^ meter, System::String ^ name, System::String ^ unit, System::String ^ description);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="meter" Type="System.Diagnostics.Metrics.Meter" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="unit" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="description" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="meter">The meter that created the instrument.</param>
<param name="name">The instrument name. cannot be <see langword="null" />.</param>
<param name="unit">Optional instrument unit of measurements.</param>
<param name="description">Optional instrument description.</param>
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.Metrics.ObservableInstrument`1" /> class using the specified meter, name, description, and unit.
All classes that extend ObservableInstrument{T} must call this constructor when constructing objects of the extended class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ObservableInstrument (System.Diagnostics.Metrics.Meter meter, string name, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? tags);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Diagnostics.Metrics.Meter meter, string name, string unit, string description, class System.Collections.Generic.IEnumerable`1<valuetype System.Collections.Generic.KeyValuePair`2<string, object>> tags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.ObservableInstrument`1.#ctor(System.Diagnostics.Metrics.Meter,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (meter As Meter, name As String, unit As String, description As String, tags As IEnumerable(Of KeyValuePair(Of String, Object)))" />
<MemberSignature Language="F#" Value="new System.Diagnostics.Metrics.ObservableInstrument<'T (requires 'T : struct)> : System.Diagnostics.Metrics.Meter * string * string * string * seq<System.Collections.Generic.KeyValuePair<string, obj>> -> System.Diagnostics.Metrics.ObservableInstrument<'T (requires 'T : struct)>" Usage="new System.Diagnostics.Metrics.ObservableInstrument<'T (requires 'T : struct)> (meter, name, unit, description, tags)" />
<MemberSignature Language="C++ CLI" Value="protected:
 ObservableInstrument(System::Diagnostics::Metrics::Meter ^ meter, System::String ^ name, System::String ^ unit, System::String ^ description, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ tags);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="meter" Type="System.Diagnostics.Metrics.Meter" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="unit" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="description" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="tags" Type="System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Object>>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="meter">The meter that created the instrument.</param>
<param name="name">The instrument name. Cannot be <see langword="null" />.</param>
<param name="unit">An optional instrument unit of measurements.</param>
<param name="description">An optional instrument description.</param>
<param name="tags">The tags to attach to the counter.</param>
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.Metrics.ObservableInstrument`1" /> class with the specified meter, name, description, and unit.</summary>
<remarks>All classes extending <see cref="T:System.Diagnostics.Metrics.ObservableInstrument`1" /> need to call this constructor when constructing an object of the extended class.</remarks>
</Docs>
</Member>
<Member MemberName="IsObservable">
<MemberSignature Language="C#" Value="public override bool IsObservable { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsObservable" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.ObservableInstrument`1.IsObservable" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property IsObservable As Boolean" />
<MemberSignature Language="F#" Value="member this.IsObservable : bool" Usage="System.Diagnostics.Metrics.ObservableInstrument<'T (requires 'T : struct)>.IsObservable" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool IsObservable { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates if the instrument is an observable instrument.</summary>
<value>
<see langword="true" /> if the instrument is metrics-observable; <see langword="false" /> otherwise.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Observe">
<MemberSignature Language="C#" Value="protected abstract System.Collections.Generic.IEnumerable<System.Diagnostics.Metrics.Measurement<T>> Observe ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<valuetype System.Diagnostics.Metrics.Measurement`1<!T>> Observe() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.ObservableInstrument`1.Observe" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function Observe () As IEnumerable(Of Measurement(Of T))" />
<MemberSignature Language="F#" Value="override this.Observe : unit -> seq<System.Diagnostics.Metrics.Measurement<'T>>" Usage="observableInstrument.Observe " />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::Collections::Generic::IEnumerable<System::Diagnostics::Metrics::Measurement<T>> ^ Observe();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Diagnostics.Metrics.Measurement<T>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Fetches the current measurements being tracked by this instrument. All classes extending ObservableInstrument{T} need to implement this method.</summary>
<returns>The current measurements tracked by this instrument.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>